home *** CD-ROM | disk | FTP | other *** search
/ CU Amiga Super CD-ROM 18 / CU Amiga Magazine's Super CD-ROM 18 (1997)(EMAP Images)(GB)[!][issue 1998-01].iso / CUCD / Programming / EasyTools / full packs / HTMLess / HTMLess.doc < prev    next >
Encoding:
Text File  |  1996-05-01  |  13.4 KB  |  368 lines
  1. *****************************************
  2. *        `HTMLess'  v2.0        *
  3. *       An OriginalWare release by      *
  4. *        Troglobyte/Darkness        *
  5. *****************************************
  6. $VER:HTMLess.doc v2.0 1.May.96 Troglobyte/Darkness
  7.  
  8. Contents
  9. ========
  10.  
  11. 1. Introduction
  12. 2. Workbench usage and ToolTypes
  13. 3. CLI usage
  14. 4. History
  15. 5. Bugs
  16. 6. OriginalWare?
  17. 7. Also available...
  18. 8. Thanks to...
  19. 9. Credits
  20.  
  21. 1. Introduction
  22. ===============
  23.  
  24. HTMLess is just another utility to extract the text inside HTML files (Web
  25. pages) and convert it to a readable text format.One month ago I released
  26. the first version, since them I received lot of EMails with bugs, ideas
  27. and support who keep me busy developing and improving HTMLess, I released
  28. 3 improved versions, today (1.May.96; btw it's my birthday *8) a major
  29. release is ready: v2.0, I hope this new version could fill the needs
  30. of everybody, my goal was a small, eficient, easy to use, fast and
  31. reliable program to convert WWW HTML pages to text files.
  32. I hope all you will find HTMLess useful.
  33.  
  34. The main features are:
  35.  
  36.  - Fast, written 100% in assembler. (Even faster since v1.2, and the fastest
  37.    with the new in v1.3 CLI option -w or the ToolType WINDOW disabled)
  38.  - Small but powerful utility (only 12000 bytes long).
  39.  - CLI and Workbench usage.
  40.  - ToolTypes support. [New since v2.0]
  41.  - Admit filenames as CLI parameters (can be launched from a
  42.    DiskMaster/DirOpus type program to autoconvert HTML's).
  43.  - All non-ASCII chars are converted.
  44.  - Output text could be formatted to easy reading.
  45.  - Can keep [href's] (like WWW adresses) in the output text.
  46.  - .HTML or .HTM filename suffix could be changed to your own defined text
  47.    extension. [New since v2.0]
  48.  - The program will report any kind of errors.
  49.  - Very easy to use...just try it.
  50.  - WYSIAWYG (WhatYouSawIsAlmostWhatYouGet)
  51.  - Great results (complex AI routines used *8).
  52.  - HTML Lists converted to text lists.
  53.  - `HTMLess' is a wonderful name. 
  54.  - No annoying requesters when starting/using/quitting program.
  55.  - It's OriginalWare (OriginalWhat?) and it's only Amiga (Yeah!).
  56.  
  57. The only requirement is the "ReqTools.library" by Nico Francois and Magnus
  58. Holmgren who fortunately is continuing the development of the indispensable
  59. reqtools library.
  60.  
  61. If you need a custom version of this program (for a personal necessity);
  62. contact me and I will try to make a customized version for you (if it isn't
  63. to difficult or too much work).
  64.  
  65. If you think the sources (100% assembler) could be useful for you (to include
  66. in a program you are developing or for learning purposes) just contact me and
  67. ask for them.
  68.  
  69.  
  70. 2. Workbench usage and ToolTypes
  71. ================================
  72.  
  73. 2.1 Workbench usage:
  74.  
  75. Just launch the program and use the file requester to select the HTML file to
  76. load and to choose the name to save the text file.
  77. (Since v1.1 this `complex' option works *8)
  78. [New since v1.2]
  79. The program will ask for another filename after saving the converted file,
  80. when you don't have more HTML files to convert, Cancel or Close the file
  81. requester to exit. (Use the icon ToolType SINGLE for just one use)
  82.  
  83. 2.2 ToolTypes [New since v2.0]
  84.  
  85. The ToolTypes of the icon will be used as default configuration.
  86. The ToolTypes are equivalent to the CLI options, but if used, all the CLI
  87. options will prevail over the ToolTypes options.
  88.  
  89. COLUMNS=x    Number of columns to format the text (x is a number, 0<x<9999)
  90.         (If x=0 the text will be `formated' like the original file)
  91. HTTP        Insert href's in the output text between "[...]" chars.
  92. WINDOW        Open a Workbench window to display info.This option is
  93.         incompatible with YAK commodity, if you use YAK disable this.
  94. SINGLE        Convert just one file and exit without asking for a new file.
  95. AUTOSAVE    Save the text without a file requester.
  96. OVERWRITE    Overwrite the original HTML file, so use with caution.
  97. EXTENSION=text  Add a text extension to the savename.
  98. PATH=Dir    Select the default start directory.
  99.  
  100. To disable options use brackets with the ToolType.
  101. Example : 
  102. WINDOW        Window enabled
  103. (WINDOW)    Window disabled
  104.  
  105.  
  106. 3. CLI usage
  107. ============
  108.  
  109. Just write the command `HTMLess' with your favourite options in any CLI/Shell
  110. window.
  111.  
  112.  `HTMLess [?] [-Cxxxx] [-H] [-W] [-S] [-A] [-O] [-E...] [-P] [filename/path]'
  113.  
  114. Write just the options or the options and the path or filename (if not
  115. filename is given or if there is any kind of problem a file requester
  116. will be used with your defined path).
  117. Options must be ahead of the file name and must be after a "-" char.
  118. Options can be together or alone (-c20h or -c -h20),  and written in capital
  119. or small letters (-HC5, -hc5 or -hC5)
  120. The -Etext option must be used separated from the others options (-hc5 -e.txt).
  121.  
  122. The available options are: 
  123.  -h     : if used "href's" will be removed.By default "href's" are included
  124.           in the output text between "[...]" chars.
  125.  -cXXXX : XXXX are 1 to 4 numbers (-c10,-c200,-c0080) to select the size of
  126.           the columns of the formated text (default size is 80 columns).
  127.       If the number is zero, text won't be formatted (-c0,-c0000)
  128. [New since v1.2]
  129.  ?, -? or -help : give CLI USAGE: info.
  130. [New since v1.3]
  131.  -w     : when used HTMLess window won't be opened.And the conversion will
  132.           be really faster; try it.Errors will be reported to the CLI
  133.           window, if it's opened.
  134.  -p     : you can define the path to your favourite HTML directory
  135.       Used without [path] is useless.
  136. [New since v2.0]
  137.  -s     : Single use, 
  138.  -a     : AutoSave, save without a requester asking for the filename. 
  139.  -o     : Overwrite, use with caution, will overwrite original file.
  140.  -e.TXT : Add a text extension to the original filename (you define the text).
  141.  
  142.  
  143. Examples:
  144.  
  145. 1. HTMLess -hc80 File1.html
  146.    Results : A text file "File1.text" without [href's] and formated to 80
  147.              columns will be saved.
  148.  
  149. 2. HTMLess -h -c0040 File2.htm
  150.    Results : A text file "File2.txt" without [href's] and formated to 40
  151.              columns will be saved.
  152.  
  153. 3. HTMLess -c0 File3.txt
  154.    Results : A text file with the same name "File3.txt" with [href's] and
  155.    unformated text will be saved.
  156.  
  157. 4. HTMLess -p RAM:Temp/HTML    (RAM:Temp/HTML is a path, not a file)
  158.    Results : File requester with the files in the directory: `RAM:Temp/HTML/...'
  159.  
  160. 5. HTMLess -e.Document File4.html
  161.    Results : A text file with the name "File4.Document"
  162.  
  163.  
  164. Common errors :
  165.  
  166. 1. Options must be after a "-" char always.
  167.    BAD: HTMLess -h c80 File1.html
  168.    OK : HTMLess -hc80 File1.html or HTMLess -h -c80 File1.html
  169.  
  170. 2. Options must be ahead of the filename.
  171.    BAD: HTMLess File1.htm -c20h
  172.    OK : HTMLess -c20h File1.htm
  173.    
  174.  
  175. 4. History
  176. ==========
  177.  
  178. Version 1.0 ( 1.April.1996) :
  179.  - First official release.
  180.  
  181. Version 1.1 ( 5.April.1996) :
  182.  - Fixed Workbench icon bug (Sorry about that stupid icon type error).
  183.  - All non-ASCII chars are supported now. (Not really, try v1.2)
  184.  - Improved conversion of HTML Lists (now are more readable).
  185.  - Some extra Line Feeds are removed (but not all, to make readable a lot
  186.    of not-very-standard HTML Web pages)
  187.  - A rarely Guru bug with small files fixed.
  188.  - Last char of the text isn't deleted now.
  189.  
  190. Version 1.2 (12.April.1996) :
  191.  - Even more speed: a lot faster when Fast memory is available. (Test it)
  192.  - You can convert several files without reloading HTMLess.  (Otto von Ruggins)
  193.  - ">" by "}", and "<" by "{" bug removed.              (Markus Krajewski)
  194.  - CLI Usage info.                              (Alfredo Soro)
  195.  - All non-ASCII chars are supported now (I said the same in v1.1 *8)
  196.  - Some rare and little system-unfriendly bugs removed.
  197.  - Improved conversion for some HTML commands ( </P>, <DT> y <H....>)
  198.  - Spaces removed at the end of lines.
  199.  - More helpful people included in this doc (Look: 6.Thanks to... *8)
  200.  
  201. Version 1.3 (16.April.1996) :
  202.  - New CLI option. -w : no window will be opened and the conversion is FASTER.
  203.  - New CLI option. -p : will permit define your own path as default dir.
  204.  - Problem with YAK commodity detected, but not fixed yet.      (John Turgoose) 
  205.  - Even more helpful people included in this doc (Look: 8.Thanks to... *8)
  206.  
  207. Version 2.0 ( 1.May.1996) :
  208.  - Added Workbench icon ToolTypes support (All the CLI options have a ToolType)
  209.  - Almost all the duplicated text titles are removed now.
  210.  - Bug fixed: filesize limit of 64 KB removed.              (Markus Krajewski)
  211.  - Bug fixed: TABS (tabulator chars) are accepted.         (Markus Krajewski)
  212.  - New WB/CLI option. -A : AutoSave, no save-filename requester. 
  213.  - New WB/CLI option. -O : OverWrite original file! (Use with caution!)
  214.  - New WB/CLI option. -S : Single use, convert just one file and exit.
  215.  - New WB/CLI option. -E.text : Add a text extension to the filename. 
  216.  - Still even more helpful people included in this doc (Read: 8.Thanks to... *8)
  217.  
  218.  
  219. ToDo List:
  220.  - Fix all the bugs that will be discovered by users (Don't try so hard *8)
  221.  - Fix the strange YAK BUG listed in `5. Bugs'.
  222.  - Display improved formated LISTS.
  223.  - Display improved formated TABLES.
  224.  - Option to convert bold and italic tags as ANSI.
  225.  - Option to convert HTML to RTF text
  226.    (useful for a future use in a word processor)
  227.  
  228.  
  229. 5. Bugs
  230. =======
  231.  
  232. [New since v1.3]
  233. There is an unknown bug in some Amigas, looks like there is a compatibility
  234. problem with the YAK commodity (thanks to John Turgoose for this info).So
  235. try to disable/unload/stop/turn off YAK when using HTMLess.
  236. The problem is a warning Guru (yellow) each time you run HTMLess, after
  237. that you can't close the HTMLess window.Since v1.3 I included a new CLI option
  238. (-w), when used HTMLess don't open his own window, but will report errors
  239. to the CLI window, if it's open.As an added bonus with this option turned
  240. on the conversion is a lot faster.
  241.  
  242. There isn't anymore KNOWN bugs at the moment in all the Amigas tested but...
  243.  
  244. If you find any bug or problem, contact me at the previous address.Please,
  245. send me a detailed report of the problem and of your Amiga computer if
  246. possible; thanks.
  247.  
  248. If you found the problem with a particular file, send me too a copy of
  249. the file.
  250.  
  251. Don't forget to tell me the current version of my program you are using.
  252.  
  253.  
  254. 6. OriginalWare ?
  255. =================
  256.  
  257. This  utility  is OriginalWare.That means if you like this program you must
  258. buy  an  original Amiga program or game, or send the money to the author of
  259. any ShareWare program or game you are using often.
  260. (This includes me, $5 or $10 will be welcome *8)
  261.  
  262. There  are  lots  of  great Amiga software like `DiskMaster', `Remind',
  263. `MultiCX', `Spot', `ReqTools.library', `Deluxe Galaga', `APlayer' and a
  264. lot more that you won't never regret to spend your money.
  265.  
  266. If you do this you support the Amiga, and if you support AMIGA you support
  267. US.Support software authors and you will get more and better software.
  268.  
  269.  
  270. This program could be included in any PD compilation at a symbolic price.
  271.  
  272. Aminet and Fred Fish collections are specifically allowed to include it.
  273.  
  274. This program could be freely included in any Web page or FTP site, but
  275. send me an EMail to know it (I can include the address in this doc).
  276.  
  277. For using them in commercial products, my written permission is required.
  278. Inclusion in magazines and diskmags will be allowed, if you send me a copy of
  279. this publication.
  280.        
  281.  
  282. 7. Also available...
  283. ====================
  284.  
  285. Others quality Amiga PD products available from me :
  286.  
  287. Aminet recent uploads :
  288.  
  289. HTMLess.lha   v2.0   text/hyper     13K v2.0 Converts HTML files in text files.
  290. DKSound.lha   v2.2   util/boot   53K Changes Workbench Sounds at each boot.
  291. MagiCA64.lha  v1.1   misc/emu     6K Converts A64/64 files to MagiC64 format.  
  292. Progress.lha  v1.0   demo/intro  73K In Progress/Darkness.1st at Euskal Party
  293. Vectoram.lha  v1.3   dev/misc    15K Draw and edit 2D vectors for demos/games
  294. TheRace5.lha  v1.5   game/2play  59K Great 100m Running game, 0-4 players.
  295.  
  296. Available soon:
  297.  
  298. ELF.lha       v1.0   text/misc         Erase Line Feeds.Use for Word Procesors.
  299. FormaText.lha v1.0   text/misc         Format texts to your chosen columns size 
  300.  
  301. All them are 100% written in pure assembler for speed and are very system 
  302. friendly in all types of Amiga computers (or that is what I hope *8).
  303.  
  304.  
  305. 8. Thanks to...
  306. ===============
  307.  
  308. Alfredo Soro for the first ßeta testing.
  309. Otto Von Ruggins for the first bug report and some tests.
  310. Philippe Duchenne for reporting some bugs and interesting ideas.
  311. Markus Krajewski for lots of bugs and nice ideas.
  312. Geoff Milnes for another bug report.
  313. John Turgoose for the problem with the YAK commodity.
  314. Jerome Chesnot for EMail support, even "TheRace" support. (R.A.M. is great!)
  315. David Cassidy for don't forget me *8) .
  316. Jose Vergara for Fido EMail support.
  317. Andrew Bruno for EMail support. 
  318. Mikael Osterhed for EMail support.
  319. Glenn Zieman for EMail support and suggestions.
  320. Joerg Plate for EMail suggestions.
  321. Derik Pyper for nice EMail support.
  322.  
  323. Hipnooxis for ALL the help and show me to use and respect the Amiga O.S.
  324.  
  325. Knackosoft/TRSI for being my best `invisible' friend.
  326.  
  327. To the `Atletico de Madrid', the best football team in Spain.
  328.  
  329. To all the Amiga developers for all the new, fun and useful stuff.
  330.  
  331. To all the Amiga users worldwide for their trust in the Amiga.
  332.  
  333. To Amiga Technologies for continue the development of the Amiga.
  334.  
  335. To VIScorp for ... (I hope to fill this space very soon)
  336.  
  337. To the Amiga...
  338.  
  339.  
  340. 9. Credits
  341. ==========
  342.  
  343. All code © 1996 by Troglobyte/Darkness.
  344.  
  345. Send money ($), JOB offers, BUGS, comments, improvements, ideas, advices,
  346. suggestions, mags, complains, and nice  PD  stuff  (like Demos, Games or
  347. Utilities).
  348.  
  349.             M. Martin Vivaldi
  350.              Av. America 60
  351.               Madrid 28028
  352.                  SPAIN
  353.  
  354. Or NetMail me at :
  355.  
  356.  Internet : bitabit@servicom.es (Faster and safer)
  357.  
  358.  FidoNet  : 2:341/28.55        Manuel Martin
  359.  
  360.  AmigaNet : 39:192/1.29        Manuel Martin
  361.  
  362.  
  363. Remember:
  364.  
  365.       Only Amiga make it possible... Only Amiga make it fun.
  366.  
  367.  
  368.